The OmniIndex methods

===========================

These are the methods that are available on the OmniIndex object.

v1 API

Create an OmniIndex object

String apiCall = "minedataml";
String body = "{\"param1\": \"value1\", \"param2\": \"value2\"}";
Map<String, String?> userDetails = {"email": "user@example.com", "uid": "123456"};
String response = await omniIndex.callOmni(apiCall, body, userDetails);
print(response);

Units (Block organisation)

OmniIndex PostgresBC is organised in units. You can create as many units as you like, but you will need to create at least one to get started. Units are frequently used as functional organisational units, such as a 'Customer' or 'Supplier' or 'Employee' or 'Patient' etc.

Note that the unit name must be unique, if you try to create a unit with the same name as an existing unit, you will get an error.

Units are referenced here by unit_name and are used in the creation of schemas and data objects.

Methods

version < 0.6.0 uses the v1 API, version >= 0.6.0 uses the v2 API.

v1 API

Full swagger documentation is available.

This is the OmniIndex Fully Homomorphic Encrypted Blockchain API, which exposes all methods that a client will require to talk to the Blockchain. This includes querying the blockchain schematic, getting lists of available folders and content as well as running analytic queries and mining data from the encrypted data. Send us an email for a sample set of data to use (we have loaded the ENRON email database as a sample for you to play with!). OmniIndex is a next-generation data analytics platform designed for businesses to gain valuable insights from their data securely and efficiently. By utilizing advanced technologies like homomorphic encryption and blockchain, it ensures your data remains private and protected from unauthorized access. This easy-to-use platform empowers your organization to make smarter, data-driven decisions with confidence, while seamlessly integrating into your existing workflows. In essence, OmniIndex offers a powerful, secure, and user-friendly solution to help you stay ahead of the competition and drive your business growth.

getblockschematicml This POST method will bring back the schematic of the Blockchain.

{
  "user": "string",
  "password": "string",
  "key": "string",
  "server": "string"
}

runanalyticqueryml This POST method will run a query on the Blockchain. To use it you are required to know the definition of the blocks that you are querying. If your where syntax includes data that has been encrypted for searching you need to use curly braces around your search string. EG: SELECT X FROM Y where thissearchableowners LIKE '%{what am i searching for}%'. The API will then convert this into a searchable ciphered stream.

{
  "unitName": "string",
  "showProtected": "string",
  "user": "string",
  "password": "string",
  "key": "string",
  "server": "string",
  "analyticQuery": "string"
}

minedataml This POST method will add a block to the chain. This is avery dynamic call, that requires a json object with the data to be sent to the server. This object MUST follow the follwing rules: Any (all) objects that need to be encrypted, the key must have the word 'Encrypt' appended to it. EG: fileContentsEncrypt. This will make sure that the SDK encrypts the value in all methods available prior to it being sent to a node.

{
  "unitName": "string",
  "user": "string",
  "password": "string",
  "key": "string",
  "server": "string",
  "data": "string"
}

OmniIndex Methods topic